<HTML>
<HEAD>
<TITLE>HELP - IncludeDocFromBody</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - IncludeDocFromBody</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','ExampleCode0',this)" class="pathLink">Example Code</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_class','HowToDocument0',this)" class="pathLink">HowToDocument</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">IncludeDocFromBody</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_member','IncludeDocFromBody2587069908','_description',this)" class="tabLinkInActive">Description</a></span>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_member','IncludeDocFromBody2587069908','_source',this)" class="tabLinkActive">Source</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Call Graph</span></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<div class="paragraph2NoTopPadding">Start Line: 161</div>
<pre class="codeExamples">
void <a href="#" onMouseOver="link('_member','IncludeDocFromBody2587069908',this); overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;IncludeDocFromBody&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Include documentation from function body.');" onMouseOut="return nd();">HowToDocument::IncludeDocFromBody</a>()
{ // Here we don't need to put the ending parenthesis after 2.1f on a newline, 
  // since the statement doesn't end until the ending '}'
  int   iSize   = 4;
  float fMAX2   = 120.0f;
  float fFloat  = iSize * 3 + fMAX2;
  /// !Inlined documentation from function body.
  /// You can add documentation from within the function body this way.
  /// It is just concatenated to the normal documentation block.\n
  /// This only works if you have set #HIDE_IN_BODY_DOCS# to #NO# in the config file (default).\n
  /// #}As of right now it does not work with \\note \\todo etc., but that's on our todo-list :-)#}
}

</pre><div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_member','_source');
</script>
